//=============================================================================
// System  : MatchKit
// File    : IPattern.cs
// Author  : Fabio Bussu  (matchkit@fabiobussu.it)
// Updated : 04/16/2013
// Note    : Copyright 2013, Fabio Bussu, All rights reserved
//
// This code is published under the Microsoft Public License (Ms-PL). A copy
// of the license should be distributed with the code.  It can also be found
// at the project website: http://matchkit.codeplex.com. This notice, the
// author's name, and all copyright notices must remain intact in all
// applications, documentation, and source files.
//
// Version     Date     Who  Comments
// ============================================================================
// 1.0.0.0  04/16/2013   FB  First draft
//=============================================================================
using System.Collections.Generic;

namespace MatchKit
{
	/// <summary>
	/// Provides the base pattern interface for the matching infrastructure.
	/// </summary>
	/// <conceptualLink target="7e345cd8-5aaa-58ad-9876-abcc9344dabc" />
	/// <conceptualLink target="0a06b2a9-5f58-409a-ba62-639cfd77bca7" />
	public interface IPattern
	{
		/// <summary>
		/// Gets or sets the name associated with the pattern.
		/// </summary>
		string CaptureName { get; set; }

		/// <summary>
		/// Gets the collection of children.
		/// </summary>
		IEnumerable<IPattern> Children { get; }

		/// <summary>
		/// Indicates whether the instance has any children. 
		/// </summary>
		bool HasChildren { get; }

		/// <summary>
		/// Perform the match logic.
		/// </summary>
		/// <param name="context">Matching context.</param>
		/// <returns>The resulted match.</returns>
		Match Match(MatchContext context);

		/// <summary>
		/// Gets a short description of the current instance.
		/// </summary>
		string HelpString { get; }

		/// <summary>
		/// Gets or sets the custom user data.
		/// </summary>
		object UserData { get; set; }

		/// <summary>
		/// Gets or sets the flag that indicates whether the current instance is
		/// a point of no return for the matching process.
		/// </summary>
		/// <conceptualLink target="7e345cd8-5aaa-58ad-9876-abcc9344dabc" />
		bool IsPointOfNoReturn { get; set; }
	}
}
